home *** CD-ROM | disk | FTP | other *** search
/ AM/FM: Amiga Musicians' Freeware Magazine 3 / AM-FM 3.adf / utilities / Proplay.doc.pp / Proplay.doc
Text File  |  1978-01-21  |  11KB  |  374 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.                       ProPlayer v1.3 - Module Player
  7.  
  8.  
  9.  
  10.                           Written by Ivar Hagen
  11.  
  12.  
  13.  
  14.                      ReqTools library by Nico François
  15.  
  16.                     Icons by Göran Larsson / SprintSoft
  17.  
  18.                    Documentation written by Göran Larsson
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25. General note about the documentation
  26. ­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­
  27.  
  28. This doc was written for people not so familar with module-players
  29. and the ReqTools.library. If you know to handle them, do not bother
  30. to continue reading, you will only get bored.
  31. The only part I recommend everyone to read is the Auto module directory-
  32. section.
  33. However, I have tried to write this doc in a way so it will be easy for
  34. everyone to find the part they are looking for. I hope you like it!
  35.  
  36.  
  37.  
  38.  
  39. ProPlay v1.3 features
  40. ­­­­­­­­­­­­­­­­­­­­­
  41.  
  42. * Supports SoundTracker/NoiseTracker/StarTrekker/ProTracker type of modules
  43.  
  44. * Small, less than 13 K
  45.  
  46. * Written in 100% assembly language
  47.  
  48. * KickStart 2.0 compatible
  49.  
  50. * Uses ReqTools.library by Nico François
  51.  
  52. * Executable from both WorkBench and Shell/CLI
  53.  
  54.  
  55.  
  56.  
  57. Preface
  58. ­­­­­­­
  59.  
  60. ProPlay was meant to be a small and fast program which behaves well together
  61. with other programs, where many other module-players fail.
  62.  
  63.  
  64.  
  65.  
  66. How to install ProPlay
  67. ­­­­­­­­­­­­­­­­­­­­­­
  68.  
  69. The ProPlay archive should contain the following files:
  70.  
  71.  
  72. * ProPlay               Guess! :-)
  73.  
  74. * ProPlay.doc           The file you are looking at.
  75.  
  76. * ProPlay.info          The icon to use with OS 1.2 - 1.3
  77.  
  78. * ProPlay_OS2.0.info    The icon to use with the new OS 2.0
  79.  
  80. * ReqTools.library      This file should be placed in your Libs: directory.
  81.                         You MUST have this file to run ProPlay from
  82.                         WorkBench.
  83.  
  84.  
  85. 2.0 icon:     If you have got OS 2.0, then just delete/rename the 1.2 - 1.3
  86.               icon, and rename ProPlay_OS2.0.info to ProPlay.info
  87.  
  88.  
  89. Auto Mod.     You have got the possibility to make ProPlay automatically
  90. dir & auto    jump to your module directory.
  91. pattern:      Select Misc on the ProPlay-window, and then Config.
  92.               The first time ProPlay's config-window is opened, it will
  93.               show the name of the directory which it has been loaded from,
  94.               you can change this to whatever you want. Here is an example:
  95.  
  96.               DH0:Music/Modules
  97.  
  98.               This will force ProPlay to automatically jump to the
  99.               directory Music/Modules on device DH0:. Then select Ok.
  100.               After that you will be asked to enter an auto pattern.
  101.               The default is Mod.. The result is that ProPlay's
  102.               filerequester only displays files with the prefix Mod.
  103.               For more info about patterns (wildcards), refer to the
  104.               section "How to use the ReqTools interface/Wildcards".
  105.  
  106.  
  107.  
  108. Running ProPlay from Shell/CLI
  109. ­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­
  110.  
  111. Is not very difficult. Type Proplay ? and a syntax appears, like this:
  112.  
  113.  
  114. Shell/CLI     ProPlay v1.3   Written by Ivar Hagen
  115. usage:        Usage: ProPlay [Path]<Modulename>
  116.  
  117.               [Path] is from were ProPlay should read the module,
  118.               and <Modulename> is the name of the module you wish to play,
  119.               here is an example:
  120.  
  121.               ProPlay DH0:Music/Modules/Mod.Caroline
  122.  
  123.               This will read the module Caroline from the directory
  124.               Music/Modules on the device DH0:
  125.  
  126.  
  127. <SPACE> is    "But I have spaces in the modulename, do I have to rename it?"
  128. ok!           No, you do not! Spaces will do fine, here is yet an example:
  129.  
  130.               ProPlay DH0:Music/Modules/Mod.Miami Jazz Style2
  131.  
  132.  
  133. Filereq from  If you only write ProPlay without any args, ProPlay will open
  134. Shell/CLI:    the ReqTools filerequester, for more information about that,
  135.               please refer to the section "How to use the ReqTools interface"
  136.  
  137.  
  138. To end the    Press both mousebuttons.
  139. playing:
  140.  
  141.  
  142.  
  143.  
  144.  
  145. Running ProPlay from WorkBench
  146. ­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­
  147.  
  148. Is very easy, you will only have to doubleclick the ProPlay-icon.
  149.  
  150.  
  151. A short in-   A window with some information appears on the screen,
  152. troduction:   and when you do not feel like watching it, a hint could
  153.               be to press <RETURN> or click the "Click anywhere!" gadget or
  154.               anywhere else on the screen to get rid of it! :-)
  155.  
  156.               At this point, the filerequester appears, and you will see
  157.               a listing of files in your modules directory if you've
  158.               set up the configuration mentioned above correctly.
  159.  
  160.               For more information how to use the filerequester etc.,
  161.               look at the section "How to use the ReqTools interface" below.
  162.  
  163.  
  164.  
  165.  
  166. How to use the ReqTools interface
  167. ­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­
  168.  
  169.  
  170. The Filerequester
  171. ­­­­­­­­­­­­­­­­­
  172.  
  173. General note: All gadgets in bold type can be executed by pressing <RETURN>.
  174.  
  175.  
  176. Scrolling:    You can scroll up/down in the file listing with the scroll
  177.               bar on the left side of the window, or by the small arrows
  178.               below the scroll bar.
  179.  
  180.  
  181. Directory     If you want to load a tune from a different directory than
  182. selection:    the current one, there are several ways to do that.
  183.  
  184.           #1. Press right mousebutton. Now you will have a listing of devices
  185.               and assigns instead of the file listing.
  186.               If you select an assign it will naturally list the device and
  187.               directories it is assigned to. Let us say that you have
  188.           assigned ST-00: to DF1:Music, then if you select the
  189.           assign ST-00: ProPlay will jump to DF1:Music.
  190.  
  191.           #2. Type the device and directory name directly into the directory
  192.               window, like this:
  193.  
  194.               DH0:Music/Tracks
  195.  
  196.               Then ProPlay will show the file listing of the directory
  197.               Music/Tracks on the device DH0:
  198.               If you write the device name instead of the name of the drive,
  199.               ProPlay will change to the name of the drive. For example,
  200.               if you write as exemplified above, and the name of the
  201.               (hard)drive is HardDisk 1:, ProPlay will change
  202.               automatically to that.
  203.  
  204. The Get-      If you are in the device- and directory list and want to return
  205. gadget:       to the last directory you were watching, press the Get gadget.
  206.               This gadget also updates the file listing in the current
  207.               directory.
  208.  
  209. Module        When you are in the directory you want to, you can select a
  210. selection:    track by doubleclick on it's filename or write it in the
  211.               filename-window. If you want to select several tracks at
  212.               one time, press the <SHIFT> key, and keep it down while
  213.               you click on the tunes you want to listen to.
  214.  
  215.  
  216. The All-      To select all tracks in the current directory,
  217. gadget:       press the All gadget.
  218.  
  219.  
  220. The Clear-    This gadget will remove all marked files in the current
  221. gadget:       directory.
  222.  
  223.  
  224. Wildcards:    In the pattern window you can write the file prefix, the
  225.               default is Mod. Then ProPlay will only show the files
  226.               which begin with Mod.
  227.               If you have got another file prefix, Tune. for example,
  228.               you write like this in the pattern window:
  229.  
  230.               Tune.#?
  231.  
  232.               This means only files that begin with Tune. will be displayed.
  233.               How to have no file prefix at all is self explanatory.
  234.  
  235.               Suffixes are also supported. They are written vice versa.
  236.               If your modulenames end with f.ex. .PT, write #?.PT in
  237.               the pattern window.
  238.  
  239.  
  240. The Hide/     This gadget disables/enables the showing of .info files.
  241. Show .info    The default setting is hide.
  242. gadget:
  243.  
  244.  
  245. The Match     Here you can mark several files with a special pattern, using
  246. gadget:       wildcards. Read about wildcards above for more info.
  247.  
  248.  
  249. The Disks     If you click this gadget you will have a list of devices and
  250. gadget:       assigns in your system. You can also select this option by
  251.               clicking right mousebutton.
  252.               If you want to get back to the last directory you were in,
  253.               press the Get gadget.
  254.               For more info, read the "Directory selection" section.
  255.  
  256.  
  257. The Parent    If you click this gadget ProPlay will jump one step back in
  258. gadget:       the directory tree.
  259.  
  260.  
  261. The Cancel &  Will result in the same thing, i.e. ProPlay jumps to its own
  262. quit-gadget:  screen where you can quit the program.
  263.               If you have not selected any module for playing, the ProPlay
  264.               window will respond "Now playing: Nothing!"
  265.  
  266.  
  267. At last:      When you are done with your selections, click the Ok gadget.
  268.  
  269.  
  270. The ProPlay-window
  271. ­­­­­­­­­­­­­­­­­­
  272.  
  273. Is quite self explanatory, anyway, here are some short instructions:
  274.  
  275.  
  276. The Next-     Clicking this gadget will result in the filerequester being
  277. gadget:       displayed. If you have selected several modules for playing,
  278.               ProPlay will load the next one.
  279.  
  280.  
  281. The Misc-     See the "Config, Info & Samples"-window section below.
  282. gadget:
  283.  
  284.  
  285. The Replay-   Will restart the module currently playing from its first
  286. gadget:       position.
  287.  
  288.  
  289. The Quit-     Yep, you guessed it! It quits ProPlay. Strange, eh? :-)
  290. gadget:
  291.  
  292.  
  293. The Config, Info & Samples window
  294. ­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­
  295.  
  296. The Misc-screen will display some info about the tune currently playing.
  297. You can also view the samples, and change ProPlay's configuration.
  298.  
  299.  
  300. Info          It will list the modulename, the size of the module in bytes,
  301. displayed:    number of patterns, and the playtime.
  302.  
  303.               The modulename may differ from the filename, ProPlay shows
  304.               the name of the module, not the file.
  305.  
  306.               Click the Done gadget or press <RETURN> to exit.
  307.  
  308.  
  309. Sample        If you select the Samples gadget, ProPlay will show a listing
  310. info:         of all samples in the module, and their size in bytes.
  311.  
  312.               Click the Done gadget or press <RETURN> to exit.
  313.  
  314. Config        Already explained in the section "How to install ProPlay/
  315. setup:        Auto Mod. dir & auto pattern"
  316.  
  317.  
  318.  
  319. Future plans
  320. ­­­­­­­­­­­­
  321.  
  322.           #1. Powerpacker library will be supported in the next version.
  323.  
  324.           #2. If you start ProPlay from Shell/CLI the program will
  325.           start its own task.
  326.  
  327.           #3. A 'fast forward' gadget.
  328.  
  329.       #4. NTSC support.
  330.  
  331.           #5. Your suggestions !
  332.  
  333.  
  334.  
  335. Thanks to
  336. ­­­­­­­­­
  337.  
  338. I would like to thank Nico François for the great reqtools library and
  339. Bug/Network for making the proplayer replay source 100%.
  340. Thanks to El Cubo for the protimer source.
  341. Greetings to the users at 'Home Sweet Home' for help and suggestions.
  342. Finally thanks to Göran Larsson for taking the time to type this
  343. brilliant doc file.
  344.  
  345.  
  346.  
  347. Want to contact ?
  348. ­­­­­­­­­­­­­­­­­
  349.  
  350. If you have any suggestions, money gifts etc. then write to:
  351.  
  352.  
  353.        Ivar Hagen
  354.  
  355.        Äpplegränd 5
  356.  
  357.        151 68 Södertälje
  358.  
  359.        Sweden
  360.  
  361.  
  362.  
  363.        "Support the programmers and the programmers will support you"
  364.  
  365.  
  366.  
  367.  
  368.  
  369.  
  370. Well, that's it. I really hope that this documentation was of some help
  371. for you, if you needed it at all.
  372.  
  373.                                         Göran Larsson / SprintSoft
  374.